Skip to content

feat: docs_bundle - #671

Merged
dcalavrezo-qorix merged 22 commits into
mainfrom
bundles
Jul 30, 2026
Merged

feat: docs_bundle#671
dcalavrezo-qorix merged 22 commits into
mainfrom
bundles

Conversation

@AlexanderLanin

Copy link
Copy Markdown
Member

Bundles!

📌 Description

🚨 Impact Analysis

  • This change does not violate any tool requirements and is covered by existing tool requirements
  • This change does not violate any design decisions
  • Otherwise I have created a ticket for new tool qualification

✅ Checklist

  • Added/updated documentation for new or changed features
  • Added/updated tests to cover the changes
  • Followed project coding standards and guidelines

@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //src:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 988efd87-e63f-4b70-a14c-fb6f6ab7dd79
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
WARNING: Target pattern parsing failed.
ERROR: Skipping '//src:license-check': no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
ERROR: no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
INFO: Elapsed time: 7.542s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

Comment thread src/extensions/score_mounts/__init__.py Fixed
Comment thread src/tests/docs_e2e/support.py Fixed
Comment thread src/tests/docs_e2e/support.py Fixed
Comment thread src/extensions/score_mounts/__init__.py Fixed
Comment thread src/tests/docs_e2e/support.py Fixed
Comment thread src/tests/docs_e2e/support.py Fixed
Comment thread docs.bzl

docs_sources_env["ACTION"] = "incremental"
py_binary(
name = "docs_combo",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving too fast. Keep docs_combo for backwards-compatibility.

Comment thread docs.bzl
Comment thread src/extensions/score_mounts/_resolver.py Fixed
Comment thread src/tests/mounts_contract/test_mount_docs_e2e.py Fixed
Comment thread src/tests/mounts_contract/test_mount_docs_e2e.py Fixed
Comment thread src/tests/mounts_contract/test_mount_docs_e2e.py Fixed
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `bazel run //:docs` | Builds documentation (also writes `metrics.json`) |
| `bazel run //:docs_check` | Verifies documentation correctness |
| `bazel run //:docs_combo` | Builds combined documentation with all external dependencies included |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please avoid the breaking change of removing :docs_combo

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs_combo only works in ref int, and we will add it there as an alias. We need to change BUILD file anyway.

@AlexanderLanin
AlexanderLanin marked this pull request as ready for review July 29, 2026 10:12
Comment thread src/extensions/score_mounts/docs/howto/index.rst Outdated
Comment thread src/extensions/score_sync_toml/__init__.py Outdated
Comment thread src/extensions/score_mounts/docs/howto/index.rst Outdated
Comment thread src/extensions/score_mounts/docs/howto/index.rst
Comment thread src/extensions/score_mounts/docs/howto/index.rst Outdated
Comment thread src/extensions/score_mounts/docs/concept/index.rst Outdated
Comment thread src/extensions/score_mounts/docs/concept/index.rst Outdated
Comment thread src/extensions/score_mounts/docs/concept/index.rst Outdated
@AlexanderLanin

Copy link
Copy Markdown
Member Author

Implemented in ef8b35d: removed the CodeQL-specific defensive-path layer while retaining the external-runfiles correction; restored needscfg_exclude_defaults = True; split the user documentation into a concise How-to and user-facing Concept; added a PlantUML diagram, DR-008-infra reference, and maintainer documentation next to score_mounts under Internals → Extensions → Mounts. Validation passed: full Bazel test suite (20/20), docs_check, HTML docs, and actionlint. Left open intentionally: entry_doc API decision, legacy docs_combo discussion, and remaining CodeQL alert threads.

Comment thread src/extensions/score_mounts/_resolver.py Fixed
Comment thread src/tests/docs_bzl/helpers.py Fixed
Comment thread src/tests/docs_bzl/test_nested_bundles.py Fixed
Comment thread src/tests/docs_bzl/test_nested_bundles.py Fixed
Comment thread src/tests/docs_bzl/test_nested_bundles.py Fixed

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some questions but they are nitpicks nothing major.
They all can be fixed in future PR's.

From my side this is a good starting point that now can be added onto.

Comment thread .github/workflows/test.yml Outdated
Comment thread bzl/bundle_rules.bzl
Comment thread bzl/bundle_rules.bzl Outdated
Comment thread bzl/bundle_rules.bzl
Comment thread bzl/bundle_rules.bzl
Comment thread bzl/bundle_rules.bzl
Comment thread bzl/bundle_rules.bzl Outdated
Comment thread bzl/bundle_rules.bzl Outdated
Comment thread bzl/bundle_rules.bzl
Comment thread src/extensions/score_sync_toml/__init__.py Outdated
@AlexanderLanin

Copy link
Copy Markdown
Member Author

previously approved + all nit picks resolved. Need a new approval.

@dcalavrezo-qorix
dcalavrezo-qorix merged commit 98a078b into main Jul 30, 2026
13 of 17 checks passed
@dcalavrezo-qorix
dcalavrezo-qorix deleted the bundles branch July 30, 2026 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

5 participants